Updating Translate to Manage Pluralization #38783

brandonhenry · 2024-03-21T23:52:20Z

Details

Fixed Issues

$ #38614
PROPOSAL: #38614 (comment)

Tests

Navigate to a chat room or report that contains messages with pluralized text related to the maximum number of participants (e.g., "You've selected the maximum number (2) of participants.").
Verify that the pluralized text is displayed correctly based on the count (e.g., "You've selected the maximum number (2) of participants." for count 2, and "You've selected the maximum number (5) of participants." for count 5).
Change the app's language to a different supported language (e.g., Spanish) and verify that the pluralized text is correctly translated and displayed based on the count.
Navigate to a chat room or report that contains messages with pluralized text related to expense counts (e.g., "2 expenses, 1 scanning").
Verify that the pluralized text is displayed correctly based on the count (e.g., "1 expense" for count 1, "2 expenses, 1 scanning" for counts 2 expenses and 1 scanning receipt).
Change the app's language to a different supported language (e.g., Spanish) and verify that the pluralized text is correctly translated and displayed based on the counts.
Navigate to a workspace settings page that shows the "Selected" count for members (e.g., "2 selected").
Verify that the pluralized text is displayed correctly based on the count (e.g., "1 selected" for count 1, "5 selected" for count 5).
Change the app's language to a different supported language (e.g., Spanish) and verify that the pluralized text is correctly translated and displayed based on the count.
Navigate to a workspace settings page that displays options related to distance rates (e.g., "Delete 2 rates", "Enable 3 rates", "Disable 1 rate", "Are you sure you want to delete these 4 rates?").
Verify that the pluralized text is displayed correctly based on the count for each option.
Change the app's language to a different supported language (e.g., Spanish) and verify that the pluralized text is correctly translated and displayed based on the count for each option.

Verify that no errors or warnings related to pluralization appear in the JavaScript console.
Verify that the pluralized text is displayed correctly based on the count across different contexts (maximum participants, expense counts, member selection, distance rates).

Offline tests

Put the device in offline mode or disconnect from the internet.
Navigate to chat rooms, reports, and workspace settings pages that contain pluralized text based on the examples mentioned in the "Tests" section.
Verify that the pluralized text is still displayed correctly based on the count, even in offline mode.
Change the app's language to a different supported language and verify that the pluralized text is still correctly translated and displayed based on the count in offline mode.

Verify that the pluralized text is displayed correctly based on the count, even in offline mode, across different contexts (maximum participants, expense counts, member selection, distance rates).

QA Steps

Navigate to a chat room or report that contains messages with pluralized text.
Verify that the pluralized text is displayed correctly based on the count.
Test with different counts (e.g., 0, 1, 2, 3, 10) to ensure the correct plural form is used for each case.
Change the app's language to each supported language and verify that the pluralized text is correctly translated and displayed based on the count in each language.
Verify that no errors or warnings related to pluralization appear in the JavaScript console.
Test on different platforms (Android, iOS, web) to ensure consistency in pluralization behavior.

Verify that the pluralized text is displayed correctly based on the count.
Verify that the pluralized text is properly cached and retrieved from the cache when revisiting the same screen.
[ ]

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/libs/Localize/index.ts

jayeshmangwani · 2024-03-26T12:08:16Z

@brandonhenry When PR will be ready for review, please add some unit tests for the Pluralization

brandonhenry · 2024-03-26T15:09:41Z

Will do @jayeshmangwani !

brandonhenry · 2024-03-31T06:06:27Z

Just wanted to leave an update here that I was working through some other PRs so haven't had that much time to put here. All done on those so this one will get my full attention this week

brandonhenry · 2024-04-04T04:10:54Z

thanks for you patience here team. had a lot of back and forth and with local build issues and other things going on, this one kind of fell behind.

I've refactored this a lot into a place I think looks good. mind taking a look? @jayeshmangwani @iwiznia

melvin-bot · 2024-04-04T04:11:00Z

@jayeshmangwani Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

…pluralization-example

jayeshmangwani · 2024-04-04T14:12:33Z

@brandonhenry Above changes will crash the app when we pass the conciergePlaceholderOptions array to localize. Can you test on your side and let us know if the crash is happening on your side, too?

iOS:

iOS-crash-localize.mov

web:

jayeshmangwani · 2024-04-04T14:14:19Z

these lines of code crashing after the changes:

App/src/pages/home/report/ReportActionCompose/ReportActionCompose.tsx

Lines 201 to 208 in 0b2f55f

    
           // Placeholder to display in the chat input. 
        
           const inputPlaceholder = useMemo(() => { 
        
               if (includesConcierge) { 
        
                   if (userBlockedFromConcierge) { 
        
                       return translate('reportActionCompose.blockedFromConcierge'); 
        
                   } 
        
                   return translate('reportActionCompose.conciergePlaceholderOptions')[conciergePlaceholderRandomIndex];

jayeshmangwani · 2024-04-04T14:33:13Z

Please update the localize test that includes the pluralized examples

brandonhenry · 2024-04-04T14:43:06Z

sure thing @jayeshmangwani - Let me check again now, thanks for the callout!

brandonhenry · 2024-04-04T15:46:01Z

so I did see the issue. fixing this and will have this back before EOD

brandonhenry · 2024-04-05T17:50:40Z

Still working through issues here

…pluralization-example

brandonhenry · 2024-04-06T03:44:04Z

@iwiznia @jayeshmangwani so the reason this was failing is because we for some reason have an array for this specific translation phrase. Every other translation in this file is a string. I think it should always be a string

brandonhenry · 2024-04-08T01:39:11Z

@jayeshmangwani @iwiznia

Alrighty, updated the function to handle that one off array translation. I also updated it so that we didn't have to alter phraseKey at all. Now, if you want to have multiple forms for a translation, you just return an object of Record<LDMLPluralRule, string> in en.ts and you are good to go.

example:

sayHello: (_count) => ({
          other: 'Say hello!',
          one: 'Say hello!!',
          two: 'Say hello!!!',
}),

we still need to pass in count for all the logic to work its magic under the hood. i don't think liner will like the unused variable 🤔

This works now though, no crashes or weirdness and the tests works

translate('reportActionsView.sayHello', {count: 1});

src/languages/en.ts

brandonhenry · 2024-06-28T13:31:52Z

Made a lot of progress yesterday. Changes pointed out more typing issues. Fixing those up, super close!

jayeshmangwani · 2024-06-28T13:35:34Z

Thanks for the update

blazejkustra · 2024-07-01T14:10:34Z

src/libs/Localize/index.ts

+type PluralFormPhrase = Record<string, string>;
+type TranslationPhraseRecord = Record<string, string | number | boolean | null | OnyxEntry<ReportAction> | undefined>;
+type TranslationPhraseArg = number | string | undefined | TranslationPhraseRecord;
+type TranslationPhraseFunction = (...args: TranslationPhraseArg[]) => string;
+type PluralTranslationPhraseFunction = (args: TranslationPhraseArg) => string;
+
+type PhraseParameters<T> = T extends PluralTranslationPhraseFunction ? [TranslationPhraseArg] : T extends TranslationPhraseFunction ? Parameters<T> : TranslationPhraseArg[];


Currently these types don't work as intended:

translate('common.addressLine') // Should error without parameters translate('common.personalAddress', {invalid: 'test'}) // Should error with parameters

brandonhenry · 2024-07-01T14:41:26Z

Taking a look now! I made quite a few changes and finally got errors for missing types in en.ts. Cleaned those up and we're just about there

…pluralization-example

jayeshmangwani · 2024-07-04T05:59:08Z

@brandonhenry Please let me know if there is anything I can help with here

iwiznia · 2024-07-04T12:15:48Z

This is taking forever to get done.... @brandonhenry can you take it to the finish line at most next week please?

brandonhenry · 2024-07-05T14:24:20Z

@iwiznia yes for sure! my apologies, main reason is focusing the smaller PRs i was working on that also seem to be taking forever due to review times...

…pluralization-example

brandonhenry · 2024-07-09T14:22:07Z

@iwiznia @jayeshmangwani I'm so sorry 😭 i am living in Houston and we got hit really bad by hurricane beryl. No power since Sunday night. Will keep updated as I also have no service so have to drive out and get it

This is really close to done as I worked on it all weekend hoping to finish before beryl but...

Osmon11 · 2024-07-13T03:50:37Z

OMG this is epic...

brandonhenry · 2024-07-13T19:45:05Z

@Osmon11 indeed. Power is back online as of today! Cleaning this up today / tomorrow

Cc. @iwiznia @jayeshmangwani

jayeshmangwani · 2024-07-17T07:08:25Z

Cleaning this up today / tomorrow

@brandonhenry can we please take this PR to the finish line today or tomorrow?

brandonhenry · 2024-07-17T16:52:16Z

@jayeshmangwani @iwiznia

Edit: I'm requesting that this one be transferred to someone else. In hindisght, I should have requested that as soon as I saw we need to change the typing to make this work. My lack of understanding of the system since this is my first expensify ticket, the 3 weeks of power outage / setback and working a 43+ hour full time job set me up for failure here...

The code is 90% done in my opinion but my lack of understanding the Expensify codebase fully + my lack of time to invest in doing so is holding this one back. My apologies but I'm available if you have any questions about the current work. Thank you for your understanding

twisterdotcom · 2024-07-18T13:18:16Z

@shubham1206agra is going to take over as contributor here.

shubham1206agra · 2024-07-22T11:32:31Z

src/languages/en.ts

+            deleteRates: (count: number) => ({
+                zero: `Delete ${count} rates`,
+                one: `Delete ${count} rate`,
+                other: `Delete ${count} rates`,
+            }),
+            enableRates: (count: number) => ({
+                zero: `Enable ${count} rates`,
+                one: `Enable ${count} rate`,
+                other: `Enable ${count} rates`,
+            }),
+            disableRates: (count: number) => ({
+                zero: `Disable ${count} rates`,
+                one: `Disable ${count} rate`,
+                other: `Disable ${count} rates`,
+            }),
+            areYouSureDelete: (count: number) => ({
+                zero: `Are you sure you want to delete ${count} rates?`,
+                one: `Are you sure you want to delete ${count} rate?`,
+                other: `Are you sure you want to delete ${count} rates?`,
+            }),


shubham1206agra · 2024-08-07T03:16:51Z

@iwiznia Can you close this PR?

init

debffae

iwiznia requested changes Mar 22, 2024

View reviewed changes

brandonhenry mentioned this pull request Apr 1, 2024

[$500] Add system for pluralizing strings to our internationalization/localization library #38614

Closed

brandonhenry changed the title ~~Test Updating Translate Pluralization~~ Updating Translate to Manage Pluralization Apr 1, 2024

brandonhenry added 2 commits April 3, 2024 23:06

Final iteration

7a562f6

move warn up

dc76775

brandonhenry marked this pull request as ready for review April 4, 2024 04:10

brandonhenry requested a review from a team as a code owner April 4, 2024 04:10

melvin-bot bot requested review from jayeshmangwani and removed request for a team April 4, 2024 04:10

brandonhenry added 3 commits April 3, 2024 23:13

add space at bottom of file

c8aa1d9

Update index.ts

f688f77

Merge remote-tracking branch 'upstream/main' into update-translation-…

91e5752

…pluralization-example

Merge remote-tracking branch 'upstream/main' into update-translation-…

301b717

…pluralization-example

brandonhenry added 2 commits April 7, 2024 20:34

updated to change even less from original and added an example

91935dc

simpler example

35b8f1c

jayeshmangwani reviewed Apr 8, 2024

View reviewed changes

src/languages/en.ts Outdated Show resolved Hide resolved

brandonhenry added 3 commits June 27, 2024 01:56

Update index.ts

f0f0f7b

Update index.ts

2f96e68

Update index.ts

317434f

blazejkustra reviewed Jul 1, 2024

View reviewed changes

brandonhenry added 2 commits July 2, 2024 07:57

last updates to make things more efficient

27a2991

Merge remote-tracking branch 'upstream/main' into update-translation-…

cb5c485

…pluralization-example

brandonhenry added 2 commits July 5, 2024 09:34

Merge remote-tracking branch 'upstream/main' into update-translation-…

8e00b78

…pluralization-example

prettier

a6bbf3d

brandonhenry requested a review from a team as a code owner July 5, 2024 14:38

brandonhenry added 6 commits July 5, 2024 10:38

Merge remote-tracking branch 'upstream/main' into update-translation-…

a7d615a

…pluralization-example

Merge remote-tracking branch 'upstream/main' into update-translation-…

958dced

…pluralization-example

revert accident

7c56086

reworking again..

ddaa1fb

more fixes

5bd8f0f

Update en.ts

feab497

shubham1206agra reviewed Jul 22, 2024

View reviewed changes

iwiznia closed this Aug 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating Translate to Manage Pluralization #38783

Updating Translate to Manage Pluralization #38783

brandonhenry commented Mar 21, 2024 •

edited

Loading

jayeshmangwani commented Mar 26, 2024

brandonhenry commented Mar 26, 2024

brandonhenry commented Mar 31, 2024

brandonhenry commented Apr 4, 2024

melvin-bot bot commented Apr 4, 2024

jayeshmangwani commented Apr 4, 2024

jayeshmangwani commented Apr 4, 2024

jayeshmangwani commented Apr 4, 2024

brandonhenry commented Apr 4, 2024

brandonhenry commented Apr 4, 2024

brandonhenry commented Apr 5, 2024

brandonhenry commented Apr 6, 2024 •

edited

Loading

brandonhenry commented Apr 8, 2024

brandonhenry commented Jun 28, 2024

jayeshmangwani commented Jun 28, 2024

blazejkustra Jul 1, 2024 •

edited

Loading

brandonhenry commented Jul 1, 2024

jayeshmangwani commented Jul 4, 2024

iwiznia commented Jul 4, 2024

brandonhenry commented Jul 5, 2024

brandonhenry commented Jul 9, 2024

Osmon11 commented Jul 13, 2024

brandonhenry commented Jul 13, 2024

jayeshmangwani commented Jul 17, 2024

brandonhenry commented Jul 17, 2024 •

edited

Loading

twisterdotcom commented Jul 18, 2024

shubham1206agra Jul 22, 2024

shubham1206agra commented Aug 7, 2024

Updating Translate to Manage Pluralization #38783

Updating Translate to Manage Pluralization #38783

Conversation

brandonhenry commented Mar 21, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

jayeshmangwani commented Mar 26, 2024

brandonhenry commented Mar 26, 2024

brandonhenry commented Mar 31, 2024

brandonhenry commented Apr 4, 2024

melvin-bot bot commented Apr 4, 2024

jayeshmangwani commented Apr 4, 2024

jayeshmangwani commented Apr 4, 2024

jayeshmangwani commented Apr 4, 2024

brandonhenry commented Apr 4, 2024

brandonhenry commented Apr 4, 2024

brandonhenry commented Apr 5, 2024

brandonhenry commented Apr 6, 2024 • edited Loading

brandonhenry commented Apr 8, 2024

brandonhenry commented Jun 28, 2024

jayeshmangwani commented Jun 28, 2024

blazejkustra Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

brandonhenry commented Jul 1, 2024

jayeshmangwani commented Jul 4, 2024

iwiznia commented Jul 4, 2024

brandonhenry commented Jul 5, 2024

brandonhenry commented Jul 9, 2024

Osmon11 commented Jul 13, 2024

brandonhenry commented Jul 13, 2024

jayeshmangwani commented Jul 17, 2024

brandonhenry commented Jul 17, 2024 • edited Loading

twisterdotcom commented Jul 18, 2024

shubham1206agra Jul 22, 2024

Choose a reason for hiding this comment

shubham1206agra commented Aug 7, 2024

brandonhenry commented Mar 21, 2024 •

edited

Loading

brandonhenry commented Apr 6, 2024 •

edited

Loading

blazejkustra Jul 1, 2024 •

edited

Loading

brandonhenry commented Jul 17, 2024 •

edited

Loading